Skip to content

ci: enrich GitHub release notes - #28

Open
m4sh-wacker wants to merge 1 commit into
mainfrom
ci/enrich-github-release-notes
Open

m4sh-wacker wants to merge 1 commit into
mainfrom
ci/enrich-github-release-notes

Conversation

@m4sh-wacker

Copy link
Copy Markdown
Collaborator

What this changes

The v0.1.1 GitHub Release contained the categorized fixes from Release Please, but lacked the contributor credits and standalone download guidance from v0.1.0. This change formats newly created root releases using the existing publication workflow.

  • What's Changed keeps the Release Please comparison, date, Conventional Commit categories, scopes, breaking notes and commit citations. Verified merge metadata adds a PR link where one is available. An existing squash-title reference or a second change from the same PR does not add another citation.
  • New Contributors uses GitHub's generated notes for the exact previous/current tag range. Each credited username must match the author of its merged repository PR. Unavailable or ambiguous metadata is skipped. GitHub's separate list of changes is discarded.
  • Standalone Edition names the versioned HTML asset, explains how to open it, and covers local processing, offline use, large inputs and updates.

Publication safeguards

The final title and body update uses the release ID returned by the creating action and checks that the published body still matches its creation response. A standalone rebuild can replace and verify the HTML asset without editing the title or description. Both historical releases are protected. This works with the existing token and action permissions.

Verification

  • Extended the pinned Release Please regression with fix-only and multi-category releases, merge and squash references, breaking changes, missing and mismatched contributor data, an edited release, manual recovery and protected tags.
  • Exercised the real workflow shell commands and publisher CLI against a mock GitHub service. The recovery path uploaded the HTML and verified its SHA-256. The automatic path sent the expected final release body to the ID-specific endpoint.
  • Project and fixture Markdown lint, project spelling and links, workflow validation, ESLint, TypeScript, all 1,213 application tests and both production builds passed locally.

This PR can be reviewed without creating a release.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant